PdfCheckBoxWidget Class
Definition
Namespace: Xfinium.Pdf.Forms
Defines an interactive check box widget.
Inheritance: Object → PdfAnnotation → PdfFieldWidget → PdfCheckWidget → PdfCheckBoxWidget
Remarks
The check box widget is the visual representation of a check box field on a PDF page.
Constructor
| Name | Description |
|---|---|
| PdfCheckBoxWidget() | Initializes a new PdfCheckBoxWidget object. |
Properties
| Name | Description |
|---|---|
| AppearanceFont | Gets or sets the widget appearance font. (inherited from PdfFieldWidget) |
| BackgroundColor | Gets or sets the widget background color. (inherited from PdfFieldWidget) |
| Blur | Gets or sets the blur action. (inherited from PdfFieldWidget) |
| BorderColor | Gets or sets the widget border color. (inherited from PdfFieldWidget) |
| BorderDashPattern | Gets or sets the array that represents the dash pattern when the BorderStyle property is set to Xfinium.Pdf.Annotations.PdfAnnotationBorderStyle.Dashed. (inherited from PdfFieldWidget) |
| BorderStyle | Gets or sets the widget border style. (inherited from PdfFieldWidget) |
| BorderWidth | Gets or sets the widget border width. (inherited from PdfFieldWidget) |
| Checked | Gets or set a value indicating whether the check widget is in the checked state. (inherited from PdfCheckWidget) |
| CheckedStateDownAppearance | Gets or sets the pressed visual appearance for the widget in checked state. (inherited from PdfCheckWidget) |
| CheckedStateNormalAppearance | Gets or sets the normal visual appearance for the widget in checked state. (inherited from PdfCheckWidget) |
| CheckedStateRolloverAppearance | Gets or sets the rollover visual appearance for the widget in checked state. (inherited from PdfCheckWidget) |
| CheckStyle | Gets or sets the style of the checked widget. (inherited from PdfCheckWidget) |
| Contents | Gets or sets the annotation contents. (inherited from PdfAnnotation) |
| CosDictionary | Gets the COS dictionary asssociated with this object. (inherited from PdfAnnotation) |
| CreationDate | Gets or sets the annotation creation date. (inherited from PdfAnnotation) |
| ExportValue | Gets or sets the widget's export value. (inherited from PdfCheckWidget) |
| Field | Gets the parent field. (inherited from PdfFieldWidget) |
| Focus | Gets or sets the focus action. (inherited from PdfFieldWidget) |
| Font | Gets or sets the widget font. (inherited from PdfFieldWidget) |
| Guid | Gets the annotation GUID. (inherited from PdfAnnotation) |
| HasStandardAppearance | Gets a flag indicating whether the annotation appearance has been created by the library internally or it has been set externally. (inherited from PdfAnnotation) |
| Hidden | Gets or sets a value indicating whether to display the annotation or not. (inherited from PdfAnnotation) |
| ID | Gets or sets the annotation ID. (inherited from PdfAnnotation) |
| Invisible | Gets or sets a value indicating whether the annotation should be displayed if it does not belong to one of the standard annotation types. (inherited from PdfAnnotation) |
| Locked | Gets or sets a value indicating whether the annotation should be modified. (inherited from PdfAnnotation) |
| LockedContents | Gets or sets a value indicating whether the annotation contents should be modified. (inherited from PdfAnnotation) |
| ModifiedDate | Gets or sets the annotation modified date. (inherited from PdfAnnotation) |
| MouseDown | Gets or sets the mouse down action. (inherited from PdfAnnotation) |
| MouseEnter | Gets or sets the mouse enter action. (inherited from PdfAnnotation) |
| MouseLeave | Gets or sets the mouse leave action. (inherited from PdfAnnotation) |
| MouseUp | Gets or sets the mouse up action. (inherited from PdfAnnotation) |
| NormalAppearance | Gets or sets the annotation normal appearance. (inherited from PdfAnnotation) |
| NoRotate | Gets or sets a value indicating whether the annotation should be rotated when the page is rotated. (inherited from PdfAnnotation) |
| NoView | Gets or sets a value indicating whether the annotation should be displayed. (inherited from PdfAnnotation) |
| NoZoom | Gets or sets a value indicating whether the annotation should be scaled to current page zoom. (inherited from PdfAnnotation) |
| Page | Gets the annotation page. (inherited from PdfAnnotation) |
| PageClose | Gets or sets the page close action. (inherited from PdfAnnotation) |
| PageInvisible | Gets or sets the page invisible action. (inherited from PdfAnnotation) |
| PageOpen | Gets or sets the page open action. (inherited from PdfAnnotation) |
| PageVisible | Gets or sets the page visible action. (inherited from PdfAnnotation) |
| Popup | Gets or sets the associated popup annotation. (inherited from PdfAnnotation) |
| Gets or sets a value indicating whether the annotation should be printed. (inherited from PdfAnnotation) |
|
| ReadOnly | Gets or sets a value indicating whether the annotation is read only. (inherited from PdfAnnotation) |
| Rotation | Gets or sets the widget rotation angle. (inherited from PdfFieldWidget) |
| TabOrder | Gets or sets the widget's tab order. (inherited from PdfFieldWidget) |
| TextColor | Gets or sets the widget text color. (inherited from PdfFieldWidget) |
| ToggleNoView | Gets or sets a value indicating whether the interpretation of NoView property should be reversed. (inherited from PdfAnnotation) |
| Type | Gets the type of the annotation. (inherited from PdfAnnotation) |
| UncheckedStateDownAppearance | Gets or sets the pressed visual appearance for the widget in unchecked state. (inherited from PdfCheckWidget) |
| UncheckedStateNormalAppearance | Gets or sets the normal visual appearance for the widget in unchecked state. (inherited from PdfCheckWidget) |
| UncheckedStateRolloverAppearance | Gets or sets the rollover visual appearance for the widget in unchecked state. (inherited from PdfCheckWidget) |
| Visibility | Gets or sets the field widget visibility. (inherited from PdfFieldWidget) |
| VisualRectangle | Gets or sets the visual rectangle of this annotation object. (inherited from PdfAnnotation) |
Methods
| Name | Description |
|---|---|
| BeginInit | Signals the start of the initialization of annotation's properties. (inherited from PdfAnnotation) |
| CreateAppearance | Creates the visual appearance for the annotation. (inherited from PdfAnnotation) |
| EndInit | Signals the end of the initialization of annotation's properties. (inherited from PdfAnnotation) |
| Flatten | Merges the widget appearance with the page content stream and sets the result as content item for the given structure element. (inherited from PdfFieldWidget) |